Model.h

Go to the documentation of this file.

/*
 * Model.h
 *
 *  Created on: Jun 2, 2009
 *      Author: David Berrios
 */

#ifndef MODEL_H_
#define MODEL_H_
#include <string>
#include <map>
#include <vector>
#include <boost/unordered_map.hpp>

#include "GeneralFileReader.h"
#include "Interpolator.h"

namespace ccmc
{
    class Interpolator;
    class Model: public GeneralFileReader
    {

        public:
            Model();

            static const int BUSY=1;
            static const int OK=2;

            virtual long open(const std::string& filename) = 0; //the individual models need a different open method
            void setModelName(std::string modelName);
            std::string getModelName();

            long loadVariable(const std::string& variable);
            long unloadVariable(const std::string& variable);
            long loadVariableInt(const std::string& variable);

            std::vector<float>* getVariableFromMapRW(const std::string& variable);
            std::vector<int>* getIntVariableFromMapRW(const std::string& variable);
            const std::vector<float>* const getVariableFromMap(const std::string& variable);
            const std::vector<int>* const getIntVariableFromMap(const std::string& variable);

            void addFloatVariableToMap(const std::string& variable, std::vector<float>* variableData);

            const std::vector<float>* const getVariableFromMap(long variable_id);
            const std::vector<int>* const getIntVariableFromMap(long variable_id);

            std::vector<float>* getVariableFromMapRW(long variable_id);
            std::vector<int>* getIntVariableFromMapRW(long variable_id);

            virtual const std::vector<std::string> getLoadedVariables();

            void setMissingValue(float missingValue);
            float getMissingValue();
            float getConversionFactorToSI(const std::string& variable);
            std::string getNativeUnit(const std::string& variable);
            std::string getSIUnit(const std::string& variable);
            int getProgress();
            int getBusyStatus();


            long close();

            virtual Interpolator* createNewInterpolator() = 0;

            //const FileReader& getFileReader();
            virtual ~Model();

        protected:
            //only need these for the BOOST_FOREACH macro to work
            typedef boost::unordered_map<std::string, std::vector<float>*> mapStringFloat;
            typedef boost::unordered_map<std::string, std::vector<int>*> mapStringInt;
            typedef boost::unordered_map<long, std::vector<float>*> mapLongFloat;
            typedef boost::unordered_map<long, std::vector<int>*> mapLongInt;
            std::string modelName;
            boost::unordered_map<std::string, float> conversionFactorsToSI; //fetch variable name first, if using variable id instead
            boost::unordered_map<std::string, std::string> variableSIUnits;
            boost::unordered_map<std::string, std::vector<float>*> variableData;
            boost::unordered_map<std::string, std::vector<int>*> variableDataInt;

            boost::unordered_map<long, std::vector<float>*> variableDataByID;
            boost::unordered_map<long, std::vector<int>*> variableDataIntByID;

            virtual void initializeConversionFactorsToSI() = 0;

            void setBusyStatus(int busyStatus);

            virtual void initializeSIUnits() = 0;
            std::string units_;

            float missingValue;
            int busyStatus;
            int progress;
            int variablesAdded;

    };
}
#endif /* MODEL_H_ */